Skip to content

docs: align sandbox quickstart defaults#1439

Closed
koriyoshi2041 wants to merge 2 commits into
OpenHands:mainfrom
koriyoshi2041:docs/default-projects-path
Closed

docs: align sandbox quickstart defaults#1439
koriyoshi2041 wants to merge 2 commits into
OpenHands:mainfrom
koriyoshi2041:docs/default-projects-path

Conversation

@koriyoshi2041

Copy link
Copy Markdown

HUMAN:

  • A human has tested these changes.

AGENT:

Docs-only change. I checked the changed markdown for trailing whitespace and searched the quickstart docs to confirm the old defaults were removed.


Why

A reviewer on #1428 suggested a follow-up PR to avoid creating both projects and Projects host folders, and to avoid a fixed old Docker image tag in the quickstart.

Summary

  • Use $HOME/Projects as the host-side default for the Docker sandbox project directory in Unix and Windows quickstarts.
  • Use ghcr.io/openhands/agent-canvas:latest instead of the old fixed 1.0.0-rc.11 image tag.
  • Keep the container mount path as /projects.

Issue Number

Follow-up from review discussion in #1428.

How to Test

  • git diff --check
  • rg -n '\$HOME/projects|Join-Path \$HOME "projects"|agent-canvas:1\.0\.0-rc\.11' README.md README.windows.md || true

Video/Screenshots

Not applicable; docs-only quickstart change.

Type

  • Bug fix
  • Feature
  • Refactor
  • Breaking change
  • Docs / chore

Notes

Risk is low. This only changes documented host defaults and image tag; it does not change the container's internal /projects path or runtime code.

@vercel

vercel Bot commented Jun 21, 2026

Copy link
Copy Markdown

@koriyoshi2041 is attempting to deploy a commit to the openhands Team on Vercel.

A member of the Team first needs to authorize it.

Comment thread README.md Outdated
-v "$HOME/.openhands:/home/openhands/.openhands" \
-v "${PROJECTS_PATH}:/projects" \
ghcr.io/openhands/agent-canvas:1.0.0-rc.11
ghcr.io/openhands/agent-canvas:latest

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be changed.

In fact, this will be reverted before next release anyway. See Release.md file.

Comment thread README.md Outdated

```sh
export PROJECTS_PATH="$HOME/projects" # directory containing your project folders
export PROJECTS_PATH="$HOME/Projects" # directory containing your project folders

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this capitalisation?

@koriyoshi2041 koriyoshi2041 force-pushed the docs/default-projects-path branch from 5a47ed4 to 0154dde Compare June 21, 2026 13:18
@koriyoshi2041 koriyoshi2041 force-pushed the docs/default-projects-path branch from 0154dde to b8c3f6e Compare June 21, 2026 13:19
@koriyoshi2041

Copy link
Copy Markdown
Author

Thanks for the review. Since the PR only changed the defaults you flagged, I restored the existing lowercase projects path and release tag and am closing this rather than leaving a no-op docs PR open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants